home *** CD-ROM | disk | FTP | other *** search
/ SPACE 2 / SPACE - Library 2 - Volume 1.iso / program / 590 / doc / english.doc < prev    next >
Encoding:
Text File  |  1992-01-06  |  7.3 KB  |  221 lines
  1.  
  2.     ==================================================
  3.  
  4. @(#)      OKAMI SHELL VERSION 1.4 - ENGLISH INSTRUCTIONS
  5.  
  6.     ==================================================
  7.             December 1st, 1991
  8.  
  9.  
  10. The Okami Shell is a Unix-like CLI for the Atari ST. It should run on any
  11. ST. 1 MB and harddisk are recommended, modem and mouse are optional.
  12. It will run on all screen resolutions, although some commands require
  13. lines to be at least 80 characters wide.
  14.  
  15. The Okami Shell resembles the Unix Bourne Shell (/bin/sh) and in
  16. particular the AIX Shell found on the IBM RT 6150 computer system. Although
  17. not completely compatible to the original, it gives the user much of
  18. the comfort of the Unix interface.
  19.  
  20. The Okami Shell has some 100 built-in (internal) commands. They are all
  21. listed in the file `help' which can be viewed with the command "help".
  22. Pressing the HELP key after entering a command will display the
  23. appropriate chapter from the file named by the shell variable HELPFILE.
  24. (No english version yet, sorry)
  25.  
  26.  
  27. SUPPORT
  28.  
  29. The Okami Shell is public domain. Everybody may possess, use, and distribute
  30. it without profit. There are no shareware fees, although donations are
  31. greately appreciated.
  32. Hints and suggestions are always welcome. So are all errors you found in
  33. the program and the documentation (including grammatical errors :)).
  34. Send them to
  35.  
  36.     Wolfram Roesler
  37.     Augustastr. 44-46
  38.     W-5100 Aachen
  39.     Germany
  40.  
  41. or via EMail:
  42.     wr@bara.oche.de
  43.     or via Mausnet gateway to: Wolfram_Roesler@ac2.maus.de
  44.  
  45.  
  46. INSTALLATION
  47.  
  48. The shell doesn't require any installation except copying the okami
  49. folder onto the hard disk or a diskette.
  50. After starting, the shell executes the file `profile' in the current
  51. directory as a shell script. So, you should tailor this file to suit
  52. your needs.
  53.  
  54.  
  55. STARTING
  56.  
  57. The shell can be started from the desktop by double-clicking on sh.ttp .
  58. Any commands entered on the command line will be executed by the shell.
  59. They may be introduced by `-c' which is ignored. Having executed these
  60. commands, the shell will exit.
  61. When a single `-' is passed as a parameter, the shell will execute the
  62. file `profile' in the current directory.
  63. It is recommended to start the shell with a `-' parameter using the
  64. supplied msh.prg since there will be trouble running GEM programs from
  65. the shell if it has been started as a ttp from desktop.
  66.  
  67. The shell installs itself in the _shell_p vector from where it can be
  68. called by successive programs. The supplied file `system.c' demonstrates
  69. how programs can call the shell this way, however any system() function
  70. from C compiler libraries should work as well.
  71.  
  72.  
  73. ENDING
  74.  
  75. The shell can be terminated by entering `exit' or pressing Ctrl-D.
  76.  
  77.  
  78. RUNNING PROGRAMS
  79.  
  80. All executable programs can be started by the shell. However, some
  81. shell variables have to be set:
  82.  
  83.     XEXT    must contain the extenders of all files that are to
  84.         be considered binaries. The default is
  85.         ".prg,.tos,.ttp,.app".
  86.     GEXT    must contain the extenders of all files that are to
  87.         be started as GEM programs. The default is ".prg".
  88.     PATH    must contain all directories (including drive id) that
  89.         are to be searched for executable files.
  90.  
  91. So, if XEXT is ".prg,.ttp" and PATH is "c:/bin,$HOME/bin", after
  92. typing "cmd", the shell will seek the files c:/bin/cmd.prg, c:/bin/cmd.ttp,
  93. $HOME/bin/cmd.prg and $HOME/bin/cmd.ttp and execute the first file thus
  94. found.
  95. Arguments will be passed to started programs in the ordinary fashion
  96. (basepage via Pexec) and using the xArg protocol. If xArg passing is
  97. not desired, it can be switched off by typing "set -a".
  98.  
  99. Any file can be run as a (binary) program with the shell command `exec'.
  100. So, typing `exec file.xyz' will run file.xyz regardless wether .xyz is
  101. in $XEXT or not. If .xys is in $XEXT, file.xyz can be run by simply
  102. typing `file'.
  103.  
  104.  
  105. SHELL SCRIPTS
  106.  
  107. A shell script is an Ascii file containing shell commands. Lines beginning
  108. with a # are interpreted as comments.
  109. Shell scripts can be started just like binary programs. However, the
  110. extenders of all files to be considered scripts must be stored in the
  111. shell variable SEXT. The default is ".sh" which should do in most cases.
  112. Any file can be run as a shell script by using the `.' command. I.e.,
  113.  
  114. . shscript.txt
  115.  
  116. will run the file shscript.txt as a shell script. Note: you must supply
  117. the full filename and extender here, PATH and SEXT are not evaluated.
  118.  
  119.  
  120. SHELL FUNCTIONS
  121.  
  122. A shell function simply is a shell script held in memory. Any file can be
  123. loaded to make a shell function by typing:
  124.  
  125. cmd(filename)
  126.  
  127. this will load the named file and store it so that it can be called by
  128. typing `cmd'. If cmd is ommited (i.e. by typing `(filename)'), the base
  129. name of filename (without extender) will be used.
  130. Example:
  131.  
  132. (showpic.sh)
  133.  
  134. will load the supplied file `showpic.sh' into memory, making a shell function
  135. named "showpic".
  136.  
  137. Shell functions can be created by shell scripts or by typing from the keyboard
  138. in the following manner:
  139.  
  140. name()
  141. {
  142.    ....................  any commands
  143. }
  144.  
  145. Removing:
  146.  
  147. name()
  148. {
  149. }
  150.  
  151. or `unset name'.
  152.  
  153. The shell command `alias' can be used to create brief shell funktions. So,
  154. `alias ll ls -l' will create a shell function named `ll' which executes
  155. `ls -l' when called.
  156.  
  157. A list of all shell functions can be created with the internal command 'fcts'.
  158.  
  159.  
  160. SHELL VARIABLES
  161.  
  162. ...setting:
  163. VAR=this is the value of VAR
  164.  
  165. ...using:
  166. echo The value of VAR is $VAR.
  167. cat $HOME/profile
  168.  
  169. ...protecting against value changes and deletion:
  170. readonly VAR
  171.  
  172. ...exporting into environment for successive programs:
  173. export VAR
  174.  
  175. ...listing:
  176. vars
  177.  
  178. ...removing:
  179. VAR=""            (removes value)
  180. VAR=            (removes variable)
  181. unset VAR        (removes variable)
  182.  
  183. Type `ver -l' to find out the maximum number of shell variables.
  184.  
  185. Predefined shell variables:
  186.  
  187. PS1        The primary shell prompt.
  188. PS2        The secondary shell prompt, used if additional input is
  189.         required (e.g. when entering shell funktions).
  190. OKAMISHELL    The shell's version number.
  191. TERM        Initially set to "Atari ST" and not yet used any further.
  192. CWD        The current directory, set by the cd command.
  193. HOME        The current directory at the time the shell was started.
  194. ETC        The name of a directory for additional files. Initially
  195.         set to $HOME.
  196. SHELL        Initially set to $HOME/sh.ttp . Should be changed if the
  197.         name of the shell program file is changed.
  198. PAGELEN     The number of lines on the screen to be used by the more
  199.         command. Initially set to 23.
  200. PIPDIR        The name of a writable drive to be used for pipelining
  201.         etc. Initially set to the same as HOME. Should be set
  202.         in profile to be a ramdisk to speed things up.
  203. NULL        The name of a file or device to which output is to be sent
  204.         which has been redirected to the NULL: device. Initially
  205.         set to PRN: but can be set to a ramdisk file.
  206. XEXT        
  207. SEXT
  208. GEXT
  209. PATH
  210.         explained above.
  211. CDPATH        A list of directories to be searched by the cd command.
  212. MANPATH        A list of directories to be searched by the man command.
  213. MANEXT        A list of file extenders to be recognized as online-help
  214.         text files for external commands, used by the man command.
  215. HELPFILE    The name of the online help file for internal commands.
  216.         Should be set to $HOME/doc/english.doc in profile since
  217.         the default is $HOME/doc/commands.doc (the german instructions
  218.         file).
  219. CLIPDIR        Contains the directory and file of the AES scrap directory.
  220.         Should only be set by the `clipb' command.
  221.